home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
PsL Monthly 1993 December
/
PSL Monthly Shareware CD-ROM (December 1993).iso
/
prgmming
/
dos
/
c
/
codelis.exe
/
MANUAL.DOC
< prev
next >
Wrap
Text File
|
1993-02-17
|
24KB
|
826 lines
CODELISTER
--------------------------------------------------------------
USER'S MANUAL
MALCOLM MCDOWELL
85 Halley St
Nepean Ontario
K2J 3R5
(613) 825-8593
.
WARRANTY
Users of "CodeLister" must accept this disclaimer of warranty:
"CodeLister" is supplied as is. The author disclaims all
warranties, expressed or implied, including, without limitation,
the warranties of merchantability and of fitness for any purpose.
The author assumes no liability for damages, direct or conse-
quential, which may result from the use of "CodeLister."
USE RESTRICTIONS
CodeLister is a "shareware program" and is provided at no charge
to the user for evaluation. Feel free to share it with your
friends, but please do not give it away altered or as part of
another system. The essence of "user-supported" software is to
provide personal computer users with quality software without
high prices, and yet to provide incentive for programmers to
continue to develop new products. If you find this program
useful and find that you are using CodeLister and continue to use
CodeLister after a reasonable trial period, you must make a
registration payment of $20.00 + Shipping and Handling (Canadian
dollars) to Malcolm McDowell. The $20.00 registration fee will
license one copy for use on any one computer at any one time.
Commercial users of CodeLister must register and pay for their
copies of CodeLister within 30 days of first use or their license
is withdrawn. Site-License arrangements may be made by
contacting Malcolm McDowell.
Anyone distributing CodeLister for any kind of remuneration must
first contact Malcolm McDowell at the address below for
authorization.
This authorization will be automatically granted to distributors
recognized by the (ASP) as adhering to its guidelines for
shareware distributors, and such distributors may begin offering
CODELISTER immediately (However Malcolm McDowell must still be
advised so that the distributor can be kept up-to-date with the
latest version of CodeLister.).
You are encouraged to pass a copy of CodeLister along to your
friends for evaluation. Please encourage them to register their
copy if they find that they can use it. All registered users
will receive a copy of the latest version of the CodeLister
package.
OMBUDSMAN NOTICE
This program is produced by a member of the Association of
Software Professionals (ASP). ASP wants to make sure that the
shareware principle works for you. If you are unable to resolve a
shareware-related problem with an ASP member by contacting the
member directly, ASP may be able to help. The ASP Ombudsman can
help you resolve a dispute or problem with an ASP member, but
does not provide technical support for members' products. Please
write to the ASP Ombudsman at 545 Grover Road, Muskegon, MI 49442
or send a CompuServe message via CompuServe Main to ASP Ombudsman
70007,3536.
TABLE OF CONTENTS
CHAPTER 1 INTRODUCTION. . . . . . . . . . . . . . . . . . . . . . . . . 1
1.1 SYSTEM REQUIREMENTS . . . . . . . . . . . . . . . . . . . . . . 1
1.2 FEATURES. . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
CHAPTER 2 INSTALLATION. . . . . . . . . . . . . . . . . . . . . . . . . 3
CHAPTER 3 RUNNING CODELISTER. . . . . . . . . . . . . . . . . . . . . . 4
3.1 Command Line Parameters. . . . . . . . . . . . . . . . . . . . 4
3.1.1 Printing Individual Files. . . . . . . . . . . . . . . . 4
3.1.2 Printing Project Files.. . . . . . . . . . . . . . . . . 4
3.1.2.1 Project File Extension. . . . . . . . . . . . . . 5
3.1.2.2 Creating Project Files. . . . . . . . . . . . . . 5
3.2 Definition of CodeLister Display.. . . . . . . . . . . . . . . 7
3.2.1 F1 - Set Configuration.. . . . . . . . . . . . . . . . . 8
3.2.1.1 Description of Configuration
Parameters.. . . . . . . . . . . . . . . . . . . . . 8
3.2.2 F2 - Continue. . . . . . . . . . . . . . . . . . . . . . 11
3.2.2.1 Display of Files Printed. . . . . . . . . . . . . 11
3.2.2.2 Stopping the Printing of Files. . . . . . . . . . 11
3.2.3 F10 - Stop. . . . . . . . . . . . . . . . . . . . . . . 11
CHAPTER 4 DEFINITION OF LISTINGS. . . . . . . . . . . . . . . . . . . . 12
CHAPTER 5 ERROR MESSAGES. . . . . . . . . . . . . . . . . . . . . . . . 13
CHAPTER 6 REGISTRATION. . . . . . . . . . . . . . . . . . . . . . . . . 14
CHAPTER 1 INTRODUCTION
1.1 SYSTEM REQUIREMENTS
CodeLister is designed to run on DOS 4.00 or higher. A VGA
monitor is recommended. The printers supported include standard
graphics printers such as:
EPSON
ROLAND
and laser printers such as:
HP LASERJET II
HP LASERJET III.
1.2 FEATURES
CodeLister is a package used to support source code development
and configuration management. Its features include:
o Formatted C source code printouts.
CodeLister will take individual source files or
project files and format them for printing. This
prevents lines of text being printed on the
perforations or off the page.
o Each page is identified with a header.
The header contains the file name, the date that
the file was edited and saved and the page number.
This allows you to identify printouts belonging to
a given date and configuration.
o Multiple Pages on a single sheet of paper.
If you are using a laser printer, CodeLister can
generate listings that have one, two or four pages
on each sheet of paper. This is ideal for storing
old listings and saving paper.
- 1 -
o Table of Contents.
A Table of Contents lists the functions and the
page in the listing where it is defined. This
allows you to quickly locate a function in the
listing or as a quick reference to function
parameters.
o Statistics
The number of lines of code and the size in bytes
of the ASCII files.
- 2 -
CHAPTER 2 INSTALLATION
To setup CodeLister perform the following steps:
1) CLIST.ZIP is a self-extracting file. Extract the files by
typing:
CLIST
at the DOS prompt.
2) A number of files will extracted. Refer to packing.lst for a
description of the files. The install.bat can be used to
install CodeLister. It assumes that you have a hard disk, or
c: drive. To continue, make sure that you are in the
directory or on the drive (ie a: or b:) containing the
install.bat file. To continue with the installation, type:
INSTALL
The installation will create a directory called C:\CLIST and
copy the files:
CLIST.EXE and
CLIST.CFG
to the directory.
3) Add the directory to your path name. Use your editor to add
the path to autoexec.bat file. This is done by adding:
;c:\clist
to the line that has "PATH=" in your autoexec.bat file.
Your are now ready to execute CodeLister from any directory on
your computer.
NOTE:
CodeLister will create a configuration file from each
directory that you execute it from.
- 3 -
CHAPTER 3 RUNNING CODELISTER
The section describes how to run CodeLister. This version of
CodeLister will create a configuration file in each directory
that it is run from.
3.1 Command Line Parameters.
To run CodeLister one of two command line parameters must be